pp108 : Task Definition

Task Definition
This topic defines a task in the form of a code and explains about the parameters.

A Task refers to an activity that can be performed independently and it has two parts as listed below. Task definition will help you with the code form of the task.

  • Task Part - An activity that is part of the Task and there can be multiple task parts within a task.
  • Related Task - A Task that is referred by this task

    The below code snippet indicates the task definition. 
    <Task id="GUID of task " name="name of task" type="UI_TASK" xmlns="http://schemas.cordys.com/task/1.0/">
    <Description>description about the task</Description>
    <Properties>
        <Property name="showOnStartPage" value="true"/>
    </Properties>
    <Input/>
    <Output/>
    <LaunchingInfo/>
    <TaskParts>
        <TaskPart id="id of task part" name="name of task part">
            <Description/>
            <ACL/>
        </TaskPart>
    </TaskParts>
    <RelatedTasks>
        <Task id="id of task" name="name of task"/>
    </RelatedTasks>
    <ACL/>
</Task>

    Parameters of Task Definition

    Example considered here is Application Registry tasks. This will help you understand the context of each parameter, The Application Registry Task is used to perform the following activities
  • Shows Application details
  • Shows installation details
  • Shows content of Application
  • Installing Applications
  • Uninstalling Applications
  • Upgrading Applications

Field

Description

Example

Task
  • ID - The unique identifier of the task.
  • Name - Name of the task.
  • Type - The type of task.
  • <GUID>
  • Application Management
  • UI task

Description

The description about the task.

Managing Applications

Properties

Any property that a task requires can be added.

showOnStartPage is set to True, to list on CUSP.

Input

The Input required to start the task.

Output

The result obtained on execution of task.

LaunchingInfo

Information required to start the task.

 
<LaunchingInfo>
    <Application class="ISVPRegistry" display="hidden" isfolder="false" taskbar="false">
        <id>baDaemon</id>
        <url>/cordys/wcp/admin/daemon.htm</url>
        <description>ISV Package Registry</description>
        <caption>ISV Package Registry</caption>
        <icon>/cordys/wcp/theme/default/icon/task/applicationmanager.png</icon>
        <Application class="ISVPRegistry" isfolder="false" menu="false">
            <id>isvRegistry</id>
            <url>/cordys/wcp/isvpackage/isvpregistry.htm</url>
            <description>ISV Package Registry</description>
            <caption>ISV Package Registry</caption>
            <icon>/cordys/wcp/theme/default/icon/task/applicationmanager.png</icon>
        </Application>
    </Application>
</LaunchingInfo>

TaskPart
  • ID - The unique identifier of the TaskPart.
  • Name - Name of the TaskPart.
  • Description - The description of the TaskPart.
  • ACL - The access rights required to execute TaskPart.
  • cordys_adminui_show_isvp_details
  • Show Application Details
  • Displays Application Details

Related Task
  • ID - The unique identifier of the task.
  • Name - Name of the task.
  • cordys_adminui_load_isvp
  • Load Applications

ACL

The access rights that are required for execution of this task.

 
<ACL>
    <ACObjectTree context="http://schemas.cordys.com/1.0/ldap"/>
</ACL>